/*
 * DG (DG Gaming Engine)  - API
 * Copyright (C) 2004  Bob Marks (marksie531@yahoo.com)
 * http://code.google.com/p/dng-gaming
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 */
package com.dg.gaming.api.common.msg
{
	import nanoxml.XMLElement;


	/**
	 * Communications class which is used to send an error from the server to a
	 * client or vice-versa.
	 *
	 * @author  Bob Marks
	 * @version Alpha 0.2.3
	 */
	public class MsgError extends MsgTableMessage
	{

		private var description:String=null; // not always needed

		private static const XML_ATT_DESCRIPTION:String="description";



		/**
		 * Constructor which creates a CommError object from the flatten ()
		 * method of another CommError object.
		 *
		 * @param message   Communication message as XML.
		 */
		public function MsgError(errorCode:int=-1, description:String=null, message:XMLElement=null)
		{

			initStatus(errorCode);
			this.description=description;
			if (message != null)
				super(message);

			if (message != null)
			{
				this.description=message.getStringAttribute(XML_ATT_DESCRIPTION);
			}
		}

		/**
		 * Return description if it exists.
		 *
		 * @return
		 */
		public function getDescription():String
		{
			return this.description;
		}

		/**
		 * @see com.dg.gaming.api.common.msg.ITransmittable#flatten()
		 */
		public override function flatten():XMLElement
		{
			var message:XMLElement=flattenWithName(Msg.ERROR);
			if (description != null)
			{
				message.setAttribute(XML_ATT_DESCRIPTION, description);
			}
			return message;
		}
	}
}